Select-Synchronous

Overview

The Select-synchronous operation is used to select documents for immediate processing and retrieves the results of the Select request by displaying the PassthroughIdentifier, Status, StatusDescription, and SelectedDocuments.

Table 1. Method
Method URL Description
POST /api/v1/Document/account/{accountId}/select-synchronous The POST method submits the accountId as part of the Select call
Table 2. Parameters
Name Type Constraints Description
accountId integer required The account used to associate to the request.

Sample Request

{
  "select": {
    "request": {
      "transactionData": "PFR4biB4bWxucz0iaHR0cDovL3NjaGVt+",
      "contentIdentifier": "BaseLibrary.PKG.Default_Default",
      "callback": {
        "authorization": {
          "authType": "HTTPBasic",
          "user": "User1",
          "password": "xxxxxxxxxx",
          "token": "<Token>"
        },
        "url": "https:<sampleURL>"
      },
      "passthroughIdentifier": "123456789"
    }
  }
}
Note: the </transactionData> element must consist of base64 data.

Sample Response

<SelectSynchronousResponse xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2">
         <SelectSynchronousResult>
            <PassthroughIdentifier xsi:nil="true" xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data"/>
            <Status xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data">Sucessful</Status>
            <StatusDescription xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data"/>
            <SelectedDocuments xmlns="http://www.wolterskluwerfs.com/2014/05/DocServices/V2/Data">
               <Documents>
                  <DocumentID>PKGD.LoanEstimate</DocumentID>
                  <Format xsi:nil="true"/>
                  <DisplayName>Loan Estimate</DisplayName>
                  <Type>Dynamic</Type>
                  <Autoselected>true</Autoselected>
                  <Suggested>false</Suggested>
                  <Copy>0</Copy>
                  <Order xsi:nil="true"/>
               </Documents>
            </SelectedDocuments>
         </SelectSynchronousResult>
      </SelectSynchronousResponse>